 /*******************************************************************************
  * Copyright (c) 2007 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  * IBM Corporation - initial API and implementation
  ******************************************************************************/

 package org.eclipse.ui.internal.handlers;

 import java.util.HashMap ;
 import java.util.Map ;

 import org.eclipse.core.commands.AbstractHandler;
 import org.eclipse.core.commands.ExecutionEvent;
 import org.eclipse.core.commands.ExecutionException;
 import org.eclipse.ui.IWorkbenchWindow;
 import org.eclipse.ui.commands.ICommandService;
 import org.eclipse.ui.commands.IElementUpdater;
 import org.eclipse.ui.handlers.HandlerUtil;
 import org.eclipse.ui.internal.WorkbenchMessages;
 import org.eclipse.ui.internal.WorkbenchWindow;
 import org.eclipse.ui.menus.UIElement;
 import org.eclipse.ui.services.IServiceScopes;

 /**
  * Handler that toggles the visibility of the coolbar/perspective bar in a given window.
  *
  * @since 3.3
  */
 public class ToggleCoolbarHandler extends AbstractHandler implements
         IElementUpdater {

     /*
      * (non-Javadoc)
      *
      * @see org.eclipse.core.commands.IHandler#execute(org.eclipse.core.commands.ExecutionEvent)
      */
     public Object execute(ExecutionEvent event) throws ExecutionException {
         final IWorkbenchWindow activeWorkbenchWindow = HandlerUtil
                 .getActiveWorkbenchWindowChecked(event);
         if (activeWorkbenchWindow instanceof WorkbenchWindow) {
             WorkbenchWindow window = (WorkbenchWindow) activeWorkbenchWindow;
             window.toggleToolbarVisibility();
             ICommandService commandService = (ICommandService) activeWorkbenchWindow
                     .getService(ICommandService.class);
             Map filter = new HashMap ();
             filter.put(IServiceScopes.WINDOW_SCOPE, window);
             commandService.refreshElements(event.getCommand().getId(), filter);
         }

         return null;
     }

     /*
      * (non-Javadoc)
      *
      * @see org.eclipse.ui.commands.IElementUpdater#updateElement(org.eclipse.ui.menus.UIElement,
      * java.util.Map)
      */
     public void updateElement(UIElement element, Map parameters) {
         IWorkbenchWindow window = (IWorkbenchWindow) element
                 .getServiceLocator().getService(IWorkbenchWindow.class);
         if (window == null || !(window instanceof WorkbenchWindow))
             return;
         element
                 .setText(isCoolbarVisible((WorkbenchWindow) window) ? WorkbenchMessages.ToggleCoolbarVisibilityAction_hide_text
                         : WorkbenchMessages.ToggleCoolbarVisibilityAction_show_text);
     }

     /**
      * Return whether the coolbar is currently visible.
      *
      * @param window
      * the window to test
      * @return whether or not the coolbar is visible
      */
     private boolean isCoolbarVisible(WorkbenchWindow window) {
         return window.getCoolBarVisible() || window.getPerspectiveBarVisible();
     }
 }

